Management API

Base Resource URL:


                    https://[server-name]/api/v01/merchants/[merchant-code]/users

Description:

Represents Users associated with the given merchant.

Supported Actions:

add

Method: POST	Implicit: No	Returns: ServiceResponse
Consumes: json, xml		Produces: json, xml

Provides user with access to a merchant. Multiple users can be added to a single merchant.

Parameters:

#	Name	Type	Required	Default	Description
01	userName	String	Yes		Identifier of a user that is going to be added to this merchant.

find

Method: GET	Implicit: Yes	Returns: User[] *
Consumes: xurl		Produces: json, xml

Lists all users currently configured for this merchant.

Parameters:

#	Name	Type	Required	Default	Description
01	offset	Integer	No	0	Index of the first record returned to the customer from the search result of a web search.
02	limit	Integer	No	100	Maximum number of records to load per single search web call made by the customer.

remove

Method: POST	Implicit: No	Returns: ServiceResponse
Consumes: json, xml		Produces: json, xml

Removes access of a user to a merchant.

Parameters:

#	Name	Type	Required	Default	Description
01	userName	String	Yes		Identifier of a user that is going to be removed from a merchant.